<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: HALL Sensor specific functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__tcpwm__functions__motif__hall.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">HALL Sensor specific functions<div class="ingroups"><a class="el" href="group__group__tcpwm.html">TCPWM        (Timer Counter PWM)</a> &raquo; <a class="el" href="group__group__tcpwm__motif.html">Motion Interface (TCPWM)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga55bccf5c2fa7d6b176dc310647f26bb4"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga55bccf5c2fa7d6b176dc310647f26bb4">Cy_TCPWM_MOTIF_Update_HLUT</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, <a class="el" href="structcy__stc__tcpwm__motif__hlut__t.html">cy_stc_tcpwm_motif_hlut_t</a> *hlut_config)</td></tr>
<tr class="memdesc:ga55bccf5c2fa7d6b176dc310647f26bb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update look up table contents for Hall Sensor in LUT mode.  <a href="#ga55bccf5c2fa7d6b176dc310647f26bb4">More...</a><br /></td></tr>
<tr class="separator:ga55bccf5c2fa7d6b176dc310647f26bb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1f96ec44319147da407ebbb98480c187"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga1f96ec44319147da407ebbb98480c187">Cy_TCPWM_MOTIF_Configure_Debounce_Bypass</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, bool bypass_sd)</td></tr>
<tr class="memdesc:ga1f96ec44319147da407ebbb98480c187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable HALL Sensor debounce stage bypass.  <a href="#ga1f96ec44319147da407ebbb98480c187">More...</a><br /></td></tr>
<tr class="separator:ga1f96ec44319147da407ebbb98480c187"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65d40de2674b7a7a5a13f91fc91defba"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga65d40de2674b7a7a5a13f91fc91defba">Cy_TCPWM_MOTIF_Update_Hall_Pattern</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base)</td></tr>
<tr class="memdesc:ga65d40de2674b7a7a5a13f91fc91defba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update Hall pattern immediately.  <a href="#ga65d40de2674b7a7a5a13f91fc91defba">More...</a><br /></td></tr>
<tr class="separator:ga65d40de2674b7a7a5a13f91fc91defba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52b8aee10a4c6506305ce5f3df79baab"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga52b8aee10a4c6506305ce5f3df79baab">Cy_TCPWM_MOTIF_HALL_Previous_Pattern_Compare</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, bool pp_compare)</td></tr>
<tr class="memdesc:ga52b8aee10a4c6506305ce5f3df79baab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable HALL Previous Pattern compare.  <a href="#ga52b8aee10a4c6506305ce5f3df79baab">More...</a><br /></td></tr>
<tr class="separator:ga52b8aee10a4c6506305ce5f3df79baab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2e0380d0c597788e79bd0aeca4882a0"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#gab2e0380d0c597788e79bd0aeca4882a0">Cy_TCPWM_MOTIF_Set_HALL_Pattern</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, uint8_t current_pattern, uint8_t expected_pattern, uint8_t previous_pattern)</td></tr>
<tr class="memdesc:gab2e0380d0c597788e79bd0aeca4882a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Hall patterns: Current, Expected and Previous patterns.  <a href="#gab2e0380d0c597788e79bd0aeca4882a0">More...</a><br /></td></tr>
<tr class="separator:gab2e0380d0c597788e79bd0aeca4882a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7fc4225ad864db7a36d8e6b22b0a72c"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#gaf7fc4225ad864db7a36d8e6b22b0a72c">Cy_TCPWM_MOTIF_Hall_Input_Sample_Trigger</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base)</td></tr>
<tr class="memdesc:gaf7fc4225ad864db7a36d8e6b22b0a72c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The application software can issue/request a sample of the Hall Inputs.  <a href="#gaf7fc4225ad864db7a36d8e6b22b0a72c">More...</a><br /></td></tr>
<tr class="separator:gaf7fc4225ad864db7a36d8e6b22b0a72c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05b98a485100cd145b9f0491f4443a7e"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga05b98a485100cd145b9f0491f4443a7e">Cy_TCPWM_MOTIF_HALL_Output_Config</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, <a class="el" href="structcy__stc__hall__output__config__t.html">cy_stc_hall_output_config_t</a> *output_config)</td></tr>
<tr class="memdesc:ga05b98a485100cd145b9f0491f4443a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the output pins for each of the hall event.  <a href="#ga05b98a485100cd145b9f0491f4443a7e">More...</a><br /></td></tr>
<tr class="separator:ga05b98a485100cd145b9f0491f4443a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga312ac31d11958aaaf333ec5bff15254e"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga312ac31d11958aaaf333ec5bff15254e">Cy_TCPWM_MOTIF_HALL_Get_Output_Modulation_Value</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base)</td></tr>
<tr class="memdesc:ga312ac31d11958aaaf333ec5bff15254e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the output modulation value.  <a href="#ga312ac31d11958aaaf333ec5bff15254e">More...</a><br /></td></tr>
<tr class="separator:ga312ac31d11958aaaf333ec5bff15254e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae582394ad9af674b4416e562734d6729"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#gae582394ad9af674b4416e562734d6729">Cy_TCPWM_MOTIF_HALL_Sample_Trigger_EdgeSel</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, <a class="el" href="group__group__tcpwm__data__structures__motif.html#ga9ede4704c47e4fbc04051f4e92e5245c">cy_en_trigger_edge_selection_t</a> edge_select)</td></tr>
<tr class="memdesc:gae582394ad9af674b4416e562734d6729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select the active edge to trigger a sample of the Hall inputs.  <a href="#gae582394ad9af674b4416e562734d6729">More...</a><br /></td></tr>
<tr class="separator:gae582394ad9af674b4416e562734d6729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51c97ad1e41d71ba64b6a95135c8dcac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__tcpwm__enums.html#ga236beaba02c8a2a1c4eec981501e7270">cy_en_tcpwm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__tcpwm__functions__motif__hall.html#ga51c97ad1e41d71ba64b6a95135c8dcac">Cy_TCPWM_MOTIF_Hall_Sensor_Init</a> (TCPWM_MOTIF_GRP_MOTIF_Type *base, <a class="el" href="structcy__stc__tcpwm__motif__hall__sensor__config__t.html">cy_stc_tcpwm_motif_hall_sensor_config_t</a> const *config)</td></tr>
<tr class="memdesc:ga51c97ad1e41d71ba64b6a95135c8dcac"><td class="mdescLeft">&#160;</td><td class="mdescRight">MOTIF module initialization in Hall sensor Mode.  <a href="#ga51c97ad1e41d71ba64b6a95135c8dcac">More...</a><br /></td></tr>
<tr class="separator:ga51c97ad1e41d71ba64b6a95135c8dcac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga55bccf5c2fa7d6b176dc310647f26bb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55bccf5c2fa7d6b176dc310647f26bb4">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Update_HLUT()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_Update_HLUT </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__tcpwm__motif__hlut__t.html">cy_stc_tcpwm_motif_hlut_t</a> *&#160;</td>
          <td class="paramname"><em>hlut_config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Update look up table contents for Hall Sensor in LUT mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">hlut_config</td><td>HALL Look Up Table Configuration <a class="el" href="structcy__stc__tcpwm__motif__hlut__t.html">cy_stc_tcpwm_motif_hlut_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Update look up table contents for Hall Sensor in LUT mode. User writes HLUT and MLUT when MOTIF is stopped. Writing into both LUT while MOTIF is started might lead to incorrect behavior. The LUT is loaded with forward or reverse pattern depending on motor desired direction. The pattern is stored in LUT independently from motor position. The hardware is responsible to find out the current motor position and to load the right hall and modulation pattern. HLUT and MLUT share the same hardware pointer for data extraction, therefore user needs to take care of keeping them aligned with respect to LUT address. A wrong programming might lead to incorrect behavior. </dd></dl>

</div>
</div>
<a id="ga1f96ec44319147da407ebbb98480c187"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f96ec44319147da407ebbb98480c187">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Configure_Debounce_Bypass()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_Configure_Debounce_Bypass </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bypass_sd</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable/Disable HALL Sensor debounce stage bypass. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">bypass_sd</td><td>Passing true will disable HALL Sensor sample delay. hall inputs are immediately sample after the low pass filter with out delay. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga65d40de2674b7a7a5a13f91fc91defba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65d40de2674b7a7a5a13f91fc91defba">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Update_Hall_Pattern()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_Update_Hall_Pattern </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Update Hall pattern immediately. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The update of the fields HALP.HCP, HALP.HEP and HALP.HPP can come from software by calling this function. </dd></dl>

</div>
</div>
<a id="ga52b8aee10a4c6506305ce5f3df79baab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga52b8aee10a4c6506305ce5f3df79baab">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_HALL_Previous_Pattern_Compare()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_HALL_Previous_Pattern_Compare </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>pp_compare</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable/Disable HALL Previous Pattern compare. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">pp_compare</td><td>Previous Pattern Compare enable or disable</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Passing true will enables the compare logic between the sampled hall input values and the previous hall pattern. HALP.HPP will hold the previous pattern. This will be used together with the comparison of the current and expected pattern to generate a wrong hall event. </dd></dl>

</div>
</div>
<a id="gab2e0380d0c597788e79bd0aeca4882a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2e0380d0c597788e79bd0aeca4882a0">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Set_HALL_Pattern()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_Set_HALL_Pattern </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>current_pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>expected_pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>previous_pattern</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the Hall patterns: Current, Expected and Previous patterns. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">current_pattern</td><td>Current Pattern</td></tr>
    <tr><td class="paramname">expected_pattern</td><td>Expected Pattern</td></tr>
    <tr><td class="paramname">previous_pattern</td><td>Previous Pattern</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>When the sampling trigger is sensed, the Hall inputs are stored and compared against the Current Pattern, HALP.HCP, the Expected Hall Pattern, HALP.HEP and the Previous Pattern HALP.HPP (the Previous Pattern comparison can be disabled) </dd></dl>

</div>
</div>
<a id="gaf7fc4225ad864db7a36d8e6b22b0a72c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf7fc4225ad864db7a36d8e6b22b0a72c">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Hall_Input_Sample_Trigger()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_Hall_Input_Sample_Trigger </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The application software can issue/request a sample of the Hall Inputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga05b98a485100cd145b9f0491f4443a7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga05b98a485100cd145b9f0491f4443a7e">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_HALL_Output_Config()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_HALL_Output_Config </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__hall__output__config__t.html">cy_stc_hall_output_config_t</a> *&#160;</td>
          <td class="paramname"><em>output_config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the output pins for each of the hall event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">output_config</td><td>HALL Output Configuration <a class="el" href="structcy__stc__hall__output__config__t.html">cy_stc_hall_output_config_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>User to make sure that no two event s are routed to same node. </dd></dl>

</div>
</div>
<a id="ga312ac31d11958aaaf333ec5bff15254e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga312ac31d11958aaaf333ec5bff15254e">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_HALL_Get_Output_Modulation_Value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_TCPWM_MOTIF_HALL_Get_Output_Modulation_Value </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the output modulation value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae582394ad9af674b4416e562734d6729"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae582394ad9af674b4416e562734d6729">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_HALL_Sample_Trigger_EdgeSel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_TCPWM_MOTIF_HALL_Sample_Trigger_EdgeSel </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__tcpwm__data__structures__motif.html#ga9ede4704c47e4fbc04051f4e92e5245c">cy_en_trigger_edge_selection_t</a>&#160;</td>
          <td class="paramname"><em>edge_select</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Select the active edge to trigger a sample of the Hall inputs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">edge_select</td><td>Edge to trigger a sample of the Hall inputs <a class="el" href="group__group__tcpwm__data__structures__motif.html#ga9ede4704c47e4fbc04051f4e92e5245c">cy_en_trigger_edge_selection_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Edge selector for the sampling trigger This field selects which edge is used of the selected MOTIFx.HSD signal to trigger a sample of the Hall inputs. </dd></dl>

</div>
</div>
<a id="ga51c97ad1e41d71ba64b6a95135c8dcac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51c97ad1e41d71ba64b6a95135c8dcac">&#9670;&nbsp;</a></span>Cy_TCPWM_MOTIF_Hall_Sensor_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__tcpwm__enums.html#ga236beaba02c8a2a1c4eec981501e7270">cy_en_tcpwm_status_t</a> Cy_TCPWM_MOTIF_Hall_Sensor_Init </td>
          <td>(</td>
          <td class="paramtype">TCPWM_MOTIF_GRP_MOTIF_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__tcpwm__motif__hall__sensor__config__t.html">cy_stc_tcpwm_motif_hall_sensor_config_t</a> const *&#160;</td>
          <td class="paramname"><em>config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>MOTIF module initialization in Hall sensor Mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the TCPWM_MOTIF instance address.</td></tr>
    <tr><td class="paramname">config</td><td>Hall sensor configuration <a class="el" href="structcy__stc__tcpwm__motif__hall__sensor__config__t.html">cy_stc_tcpwm_motif_hall_sensor_config_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the status of the operation. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
